API

Human resource APIs

POST human-resources/courses

Creates a new course for human resources

HTTP method POST
URI https://api.rambase.net/human-resources/courses
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 2983, version 6

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Course>
2
     <Name
Name

Required/mandatory field

Name of course

>{String}</Name>
3
     <CourseProvider
CourseProvider

Name of the provider of the course

This field is optional.

>{String}</CourseProvider>
4
     <Length
Length

Length of the course in hours

This field is optional.

>{String}</Length>
5
     <Description
Description

Description of the course

This field is optional.

>{String}</Description>
6
     <ExclusivelyForCompany
ExclusivelyForCompany

Company this course belongs to

This field is optional.

>
7
          <CompanyId
CompanyId

Company identifier

Minimum value: 100

This field is optional.

>{Integer}</CompanyId>
8
     </ExclusivelyForCompany>
9
</Course>
1
{
2
     "course": {
3
          "name
Name

Required/mandatory field

Name of course

": "{String}",
4
          "courseProvider
CourseProvider

Name of the provider of the course

This field is optional.

": "{String}",
5
          "length
Length

Length of the course in hours

This field is optional.

": "{String}",
6
          "description
Description

Description of the course

This field is optional.

": "{String}",
7
          "exclusivelyForCompany
ExclusivelyForCompany

Company this course belongs to

This field is optional.

": {
8
               "companyId
CompanyId

Company identifier

Minimum value: 100

This field is optional.

": "{Integer}"
9
          }
10
     }
11
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Course>
2
     <CourseId
CourseId

Course identifier

>{Integer}</CourseId>
3
     <Status
Status

Status of course

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Name
Name

Name of course

>{String}</Name>
6
     <CourseProvider
CourseProvider

Name of the provider of the course

>{String}</CourseProvider>
7
     <Length
Length

Length of the course in hours

>{String}</Length>
8
     <Description
Description

Description of the course

>{String}</Description>
9
     <ExclusivelyForCompany
ExclusivelyForCompany

Company this course belongs to

>
10
          <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
11
          <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
12
          <CompanyLink
CompanyLink

Company reference

>{String}</CompanyLink>
13
     </ExclusivelyForCompany>
14
     <CourseLink
CourseLink

Course reference

>{String}</CourseLink>
15
</Course>
1
{
2
     "course": {
3
          "courseId
CourseId

Course identifier

": "{Integer}",
4
          "status
Status

Status of course

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "name
Name

Name of course

": "{String}",
7
          "courseProvider
CourseProvider

Name of the provider of the course

": "{String}",
8
          "length
Length

Length of the course in hours

": "{String}",
9
          "description
Description

Description of the course

": "{String}",
10
          "exclusivelyForCompany
ExclusivelyForCompany

Company this course belongs to

": {
11
               "companyId
CompanyId

Company identifier

": "{Integer}",
12
               "database
Database

Abbreviation/code to identify the company

": "{String}",
13
               "companyLink
CompanyLink

Company reference

": "{String}"
14
          },
15
          "courseLink
CourseLink

Course reference

": "{String}"
16
     }
17
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100140 HTTP 404 Company not found